<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs for page timeline_helper.php</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="file-name">/helpers/timeline_helper.php</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-functions">Functions</a>
			</div>
	<div class="info-box-body">	
		<!-- ========== Info from phpDoc block ========= -->
		
			</div>
</div>
		

	
	
	
	<a name="sec-functions"></a>	
	<div class="info-box">
		<div class="info-box-title">Functions</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<span class="disabled">Functions</span>
		</div>
		<div class="info-box-body">	
			<a name="functioncreateSlidebBackgroundImage" id="functioncreateSlidebBackgroundImage"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="method-title">createSlidebBackgroundImage</span> (line <span class="line-number">19</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates slider background image.</p>
	<ul class="tags">
				<li><span class="field">return:</span> path to background image.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			createSlidebBackgroundImage
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$texture_file</span>, [<span class="var-type">integer</span>&nbsp;<span class="var-name">$min_year</span> = <span class="var-default">0</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$max_year</span> = <span class="var-default">1000</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$bg_color</span> = <span class="var-default">&#039;000000&#039;</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$number_color</span> = <span class="var-default">&#039;ffffff&#039;</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$width</span> = <span class="var-default">20</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$height</span> = <span class="var-default">400</span>])
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$texture_file</span><span class="var-description">: path to file with image placed in background.</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$min_year</span><span class="var-description">: minimum year in slider.</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$max_year</span><span class="var-description">: maximum year in slider.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$bg_color</span><span class="var-description">: background color value in hex notation.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$number_color</span><span class="var-description">: color value for number segments in hex notation.</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$width</span><span class="var-description">: image width.</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$height</span><span class="var-description">: image height.</span>			</li>
				</ul>
		
	
</div>
<a name="functiongetGD2ImageFromFile" id="functiongetGD2ImageFromFile"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="method-title">getGD2ImageFromFile</span> (line <span class="line-number">136</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Creates gd2 image resource by file extension.</p>
<p class="description"><p>Returns NULL on error.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> gd2 image or NULL on error.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">resource</span>
		<span class="method-name">
			getGD2ImageFromFile
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$file</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$file</span><span class="var-description">: path to file.</span>			</li>
				</ul>
		
	
</div>
<a name="functiongetRGBFromHexColor" id="functiongetRGBFromHexColor"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="method-title">getRGBFromHexColor</span> (line <span class="line-number">101</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Calculate color components from color in hex notation.</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getRGBFromHexColor
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$hex_color</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$red</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$green</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$blue</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$red</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$green</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$blue</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$hex_color</span><span class="var-description">: color in hex notation.</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$red</span><span class="var-description">: return value of red component.</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$green</span><span class="var-description">: return value of green component.</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$blue</span><span class="var-description">: return value of blue component.</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$red</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$green</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$blue</span>			</li>
				</ul>
		
	
</div>
<a name="functiongetYCoordinate" id="functiongetYCoordinate"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="method-title">getYCoordinate</span> (line <span class="line-number">122</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Calculates y coordinate of given value.</p>
	<ul class="tags">
				<li><span class="field">return:</span> calculated value.</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">double</span>
		<span class="method-name">
			getYCoordinate
		</span>
					(<span class="var-type">integer</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$min_year</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$max_year</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$height</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$value</span><span class="var-description">: value to calculate from.</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$min_year</span><span class="var-description">: minimum year at timeline.</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$max_year</span><span class="var-description">: maximum year at timeline.</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$height</span><span class="var-description">: height of image.</span>			</li>
				</ul>
		
	
</div>
		</div>
	</div>
	
	<p class="notes" id="credit">
		Documentation generated on Tue, 15 Jan 2013 16:54:10 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
	</p>
	</div></body>
</html>